Osmosis - gRPC Gateway docs (1.0.0)

Download OpenAPI specification:Download

A REST interface for state queries, legacy transactions

Query

CurrentEpoch provide current epoch of specified identifier

query Parameters

identifier

string

Responses

EpochInfos provide running epochInfos

Responses

CFMMConcentratedPoolLinks returns migration links between CFMM and Concentrated pools.

Responses

ConcentratedPoolIdLinkFromBalancer returns the pool id of the concentrated pool that is linked with the given CFMM pool.

path Parameters

cfmm_pool_id

required

string <uint64>

Responses

PoolsWithFilter allows you to query specific pools with requested parameters

query Parameters

min_liquidity	string String of the coins in single string seperated by comma. Ex) 10uatom,100uosmo.
pool_type	string
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Deprecated: please use the alternative in x/poolmanager

Responses

PoolType returns the type of the pool. Returns "Balancer" as a string literal when the pool is a balancer pool. Errors if the pool is failed to be type caseted.

path Parameters

pool_id

required

string <uint64>

Responses

Pools

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters

pool_id

required

string <uint64>

Responses

CalcExitPoolCoinsFromShares

path Parameters

pool_id

required

string <uint64>

query Parameters

share_in_amount

string

Responses

CalcJoinPoolShares

path Parameters

pool_id

required

string <uint64>

Responses

PoolParams

path Parameters

pool_id

required

string <uint64>

Responses

SpotPrice defines a gRPC query handler that returns the spot price given a base denomination and a quote denomination.

path Parameters

pool_id

required

string <uint64>

query Parameters

base_asset_denom	string
quote_asset_denom	string

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters

pool_id

required

string <uint64>

Responses

TotalShares

path Parameters

pool_id

required

string <uint64>

Responses

TotalLiquidity

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters

pool_id

required

string <uint64>

query Parameters

sender	string
token_in	string

Responses

Deprecated: please use the alternative in x/poolmanager

path Parameters

pool_id

required

string <uint64>

query Parameters

sender	string
token_out	string

Responses

ActiveGauges returns active gauges

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

ActiveGaugesPerDenom returns active gauges by denom

query Parameters

denom	string Desired denom when querying active gauges.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

AllGroups returns all groups

Responses

AllGroupsGauges returns all group gauges

Responses

AllGroupsWithGauge returns all groups with their group gauge

Responses

GaugeByID returns gauges by their respective ID

path Parameters

id

required

string <uint64>

Gauge ID being queried

Responses

Gauges returns both upcoming and active gauges

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

GroupByGroupGaugeID returns a group given its group gauge ID

path Parameters

id

required

string <uint64>

Responses

LockableDurations returns lockable durations that are valid to distribute incentives for

Responses

ModuleToDistributeCoins returns coins that are going to be distributed

Responses

RewardsEst returns an estimate of the rewards from now until a specified time in the future The querier either provides an address or a set of locks for which they want to find the associated rewards

path Parameters

owner

required

string

Address that is being queried for future estimated rewards

query Parameters

lock_ids	Array of strings <uint64> Lock IDs included in future reward estimation.
end_epoch	string <int64> Upper time limit of reward estimation Lower limit is current epoch.

Responses

Returns scheduled gauges that have not yet occured

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

UpcomingGaugesPerDenom returns scheduled gauges that have not yet occured by denom

query Parameters

denom	string Filter for upcoming gauges that match specific denom.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Return a locked coins that can't be withdrawn

path Parameters

owner

required

string

Responses

Returns account locked records with a specific duration

path Parameters

owner

required

string

query Parameters

duration

string

Responses

Returns account locked records with longer duration

path Parameters

owner

required

string

query Parameters

duration

string

Responses

Returns account's locked records for a denom with longer duration

path Parameters

owner

required

string

query Parameters

duration	string
denom	string

Responses

Returns account locked records with longer duration excluding tokens started unlocking

path Parameters

owner

required

string

query Parameters

duration

string

Responses

Returns locked records of an account with unlock time beyond timestamp

path Parameters

owner

required

string

query Parameters

timestamp

string <date-time>

Responses

Returns lock records by address, timestamp, denom

path Parameters

owner

required

string

query Parameters

timestamp	string <date-time>
denom	string

Responses

Returns locked records of an account with unlock time beyond timestamp excluding tokens started unlocking

path Parameters

owner

required

string

query Parameters

timestamp

string <date-time>

Responses

Returns unlockable coins which are not withdrawn yet

path Parameters

owner

required

string

Responses

Returns unlocked records with unlock time before timestamp

path Parameters

owner

required

string

query Parameters

timestamp

string <date-time>

Responses

Returns unlocking coins

path Parameters

owner

required

string

Responses

Returns lock record by id

path Parameters

lock_id

required

string <uint64>

Responses

Returns lock record by id

path Parameters

lock_id

required

string <uint64>

Responses

Returns total locked per denom with longer past given time

query Parameters

denom	string
duration	string

Responses

Return full balance of the module

Responses

Return locked balance of the module

Responses

Returns next lock ID

Responses

Params returns lockup params.

Responses

Returns synthetic lockup by native lockup id

path Parameters

lock_id

required

string <uint64>

Responses

Returns synthetic lockup by native lockup id Deprecated: use SyntheticLockupByLockupID instead

path Parameters

lock_id

required

string <uint64>

Responses

EpochProvisions returns the current minting epoch provisions value.

Responses

Params returns the total set of minting parameters.

Responses

DistrInfo returns the pool's matching gauge ids and weights.

Responses

ExternalIncentiveGauges returns external incentive gauges.

Responses

GaugeIds takes the pool id and returns the matching gauge ids and durations

path Parameters

pool_id

required

string <uint64>

Responses

IncentivizedPools returns currently incentivized pools

Responses

LockableDurations returns lock durations for pools.

Responses

Params returns pool incentives params.

Responses

Returns all of a user's full range CL positions that are superfluid staked.

path Parameters

delegator_address

required

string

Responses

UserConcentratedSuperfluidPositionsUndelegating

path Parameters

delegator_address

required

string

Responses

Returns all registered superfluid assets.

Responses

Returns all superfluid intermediary accounts.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Returns the total amount of osmo superfluidly staked. Response is denominated in uosmo.

Responses

Returns the osmo equivalent multiplier used in the most recent epoch.

query Parameters

denom

string

Responses

Returns superfluid asset type, whether if it's a native asset or an lp share.

query Parameters

denom

string

Responses

Returns intermediary account connected to a superfluid staked lock by id

path Parameters

lock_id

required

string <uint64>

Responses

Returns the amount of a specific denom delegated to a specific validator This is labeled an estimate, because the way it calculates the amount can lead rounding errors from the true delegated amount

query Parameters

validator_address	string
denom	string

Responses

Params returns the total set of superfluid parameters.

Responses

Returns the coins superfluid delegated for the delegator, validator, denom triplet

query Parameters

delegator_address	string
validator_address	string
denom	string

Responses

Returns all the delegated superfluid poistions for a specific delegator.

path Parameters

delegator_address

required

string

Responses

Returns all the superfluid positions of a specific denom delegated to one validator

query Parameters

validator_address	string
denom	string

Responses

Returns all the undelegating superfluid poistions for a specific delegator.

path Parameters

delegator_address

required

string

query Parameters

denom

string

Responses

Returns the specified delegations for a specific delegator

path Parameters

delegator_address

required

string

Responses

Returns a list of whitelisted pool ids to unpool.

Responses

DenomAuthorityMetadata defines a gRPC query method for fetching DenomAuthorityMetadata for a particular denom.

path Parameters

denom

required

string

Responses

BeforeSendHookAddress defines a gRPC query method for getting the address registered for the before send hook.

path Parameters

denom

required

string

Responses

DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator.

path Parameters

creator

required

string

Responses

Params defines a gRPC query method that returns the tokenfactory module's parameters.

Responses

Returns a list of all base denom tokens and their corresponding pools.

Responses

Returns the poolID for a specified denom input.

path Parameters

denom

required

string

Responses

FeeTokens returns a list of all the whitelisted fee tokens and their corresponding pools. It does not include the BaseDenom, which has its own query endpoint

Responses

DenomSpotPrice returns all spot prices by each registered token denom.

query Parameters

denom

string

Responses

Accounts returns all the existing accounts

Since: cosmos-sdk 0.43

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Account returns account details based on address.

path Parameters

address

required

string

address defines the address to query for.

Responses

ModuleAccounts returns all the existing module accounts.

Responses

Params queries all parameters.

Responses

Returns list of `Authorization`, granted to the grantee by the granter.

query Parameters

granter	string
grantee	string
msg_type_url	string Optional, msg_type_url, when set, will query only grants matching given msg type.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

GranteeGrants returns a list of `GrantAuthorization` by grantee.

path Parameters

grantee

required

string

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

GranterGrants returns list of `Authorization`, granted by granter.

path Parameters

granter

required

string

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

AllBalances queries the balance of all coins for a single account.

path Parameters

address

required

string

address is the address to query balances for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Balance queries the balance of a single coin for a single account.

path Parameters

address

required

string

address is the address to query balances for.

query Parameters

denom

string

denom is the coin denom to query balances for.

Responses

BaseDenom queries for a base denomination given a denom that can either be the base denom itself or a metadata denom unit that maps to the base denom.

query Parameters

denom

string

Responses

DenomsMetadata queries the client metadata for all registered coin denominations.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

DenomsMetadata queries the client metadata of a given coin denomination.

path Parameters

denom

required

string

denom is the coin denom to query the metadata for.

Responses

Params queries the parameters of x/bank module.

Responses

TotalSupply queries the total supply of all coins.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

SupplyOf queries the supply of a single coin.

path Parameters

denom

required

string

denom is the coin denom to query balances for.

Responses

TotalSupplyWithoutOffset queries the total supply of all coins.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

SupplyOf queries the supply of a single coin.

path Parameters

denom

required

string

denom is the coin denom to query balances for.

Responses

CommunityPool queries the community pool coins.

Responses

DelegationTotalRewards queries the total rewards accrued by a each validator.

path Parameters

delegator_address

required

string

delegator_address defines the delegator address to query for.

Responses

DelegationRewards queries the total rewards accrued by a delegation.

path Parameters

delegator_address required	string delegator_address defines the delegator address to query for.
validator_address required	string validator_address defines the validator address to query for.

Responses

DelegatorValidators queries the validators of a delegator.

path Parameters

delegator_address

required

string

delegator_address defines the delegator address to query for.

Responses

DelegatorWithdrawAddress queries withdraw address of a delegator.

path Parameters

delegator_address

required

string

delegator_address defines the delegator address to query for.

Responses

Params queries params of the distribution module.

Responses

ValidatorCommission queries accumulated commission for a validator.

path Parameters

validator_address

required

string

validator_address defines the validator address to query for.

Responses

ValidatorOutstandingRewards queries rewards of a validator address.

path Parameters

validator_address

required

string

validator_address defines the validator address to query for.

Responses

ValidatorSlashes queries slash events of a validator.

path Parameters

validator_address

required

string

validator_address defines the validator address to query for.

query Parameters

starting_height	string <uint64> starting_height defines the optional starting height to query the slashes.
ending_height	string <uint64> starting_height defines the optional ending height to query the slashes.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

AllEvidence queries all evidence.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Evidence queries evidence based on evidence hash.

path Parameters

evidence_hash

required

string <byte>

evidence_hash defines the hash of the requested evidence.

Responses

Allowance returns fee granted to the grantee by the granter.

path Parameters

granter required	string granter is the address of the user granting an allowance of their funds.
grantee required	string grantee is the address of the user being granted an allowance of another user's funds.

Responses

Allowances returns all the grants for address.

path Parameters

grantee

required

string

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Params queries all parameters of the gov module.

path Parameters

params_type

required

string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

Responses

Proposals queries all proposals based on given status.

query Parameters

proposal_status	string Default: "PROPOSAL_STATUS_UNSPECIFIED" Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED" proposal_status defines the status of the proposals. PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status. PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period. PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period. PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed. PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected. PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
voter	string voter defines the voter address for the proposals.
depositor	string depositor defines the deposit addresses from the proposals.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Proposal queries proposal details based on ProposalID.

path Parameters

proposal_id

required

string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Deposits queries all deposits of a single proposal.

path Parameters

proposal_id

required

string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Deposit queries single deposit information based proposalID, depositAddr.

path Parameters

proposal_id required	string <uint64> proposal_id defines the unique id of the proposal.
depositor required	string depositor defines the deposit addresses from the proposals.

Responses

TallyResult queries the tally of a proposal vote.

path Parameters

proposal_id

required

string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Votes queries votes of a given proposal.

path Parameters

proposal_id

required

string <uint64>

proposal_id defines the unique id of the proposal.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Vote queries voted information based on proposalID, voterAddr.

path Parameters

proposal_id required	string <uint64> proposal_id defines the unique id of the proposal.
voter required	string voter defines the oter address for the proposals.

Responses

AnnualProvisions current minting annual provisions value.

Responses

Inflation returns the current minting inflation value.

Responses

Params returns the total set of minting parameters.

Responses

Params queries a specific parameter of a module, given its subspace and key.

query Parameters

subspace	string subspace defines the module to query the parameter for.
key	string key defines the key of the parameter in the subspace.

Responses

Params queries the parameters of slashing module

Responses

SigningInfos queries signing info of all validators

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

SigningInfo queries the signing info of given cons address

path Parameters

cons_address

required

string

cons_address is the address to query signing info of

Responses

DelegatorDelegations queries all delegations of a given delegator address.

path Parameters

delegator_addr

required

string

delegator_addr defines the delegator address to query for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Redelegations queries redelegations of given address.

path Parameters

delegator_addr

required

string

delegator_addr defines the delegator address to query for.

query Parameters

src_validator_addr	string src_validator_addr defines the validator address to redelegate from.
dst_validator_addr	string dst_validator_addr defines the validator address to redelegate to.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

path Parameters

delegator_addr

required

string

delegator_addr defines the delegator address to query for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

DelegatorValidators queries all validators info for given delegator address.

path Parameters

delegator_addr

required

string

delegator_addr defines the delegator address to query for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

DelegatorValidator queries validator info for given delegator validator pair.

path Parameters

delegator_addr required	string delegator_addr defines the delegator address to query for.
validator_addr required	string validator_addr defines the validator address to query for.

Responses

HistoricalInfo queries the historical info for given height.

path Parameters

height

required

string <int64>

height defines at which height to query the historical info.

Responses

Parameters queries the staking parameters.

Responses

Pool queries the pool info.

Responses

Validators queries all validators that match the given status.

query Parameters

status	string status enables to query for validators matching a given status.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Validator queries validator info for given validator address.

path Parameters

validator_addr

required

string

validator_addr defines the validator address to query for.

Responses

ValidatorDelegations queries delegate info for given validator.

path Parameters

validator_addr

required

string

validator_addr defines the validator address to query for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Delegation queries delegate info for given validator delegator pair.

path Parameters

validator_addr required	string validator_addr defines the validator address to query for.
delegator_addr required	string delegator_addr defines the delegator address to query for.

Responses

UnbondingDelegation queries unbonding info for given validator delegator pair.

path Parameters

validator_addr required	string validator_addr defines the validator address to query for.
delegator_addr required	string delegator_addr defines the delegator address to query for.

Responses

ValidatorUnbondingDelegations queries unbonding delegations of a validator.

path Parameters

validator_addr

required

string

validator_addr defines the validator address to query for.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

AppliedPlan queries a previously applied upgrade plan by its name.

path Parameters

name

required

string

name is the name of the applied plan to query for.

Responses

CurrentPlan queries the current upgrade plan.

Responses

ModuleVersions queries the list of module versions from state.

Since: cosmos-sdk 0.43

query Parameters

module_name

string

module_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state.

Responses

UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)

path Parameters

last_height

required

string <int64>

last height of the current chain must be sent in request as this is the height under which next consensus state is stored

Responses

Service

GetLatestBlock returns the latest block.

Responses

GetBlockByHeight queries block for given height.

path Parameters

height

required

string <int64>

Responses

GetNodeInfo queries the current node info.

Responses

GetSyncing queries node syncing.

Responses

GetLatestValidatorSet queries latest validator-set.

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

GetValidatorSetByHeight queries validator-set at a given height.

path Parameters

height

required

string <int64>

query Parameters

pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43

Responses

Simulate simulates executing a transaction for estimating gas usage.

Request Body schema: application/json

	object (cosmos.tx.v1beta1.Tx) Tx is the standard type used for broadcasting transactions.
tx_bytes	string <byte> tx_bytes is the raw transaction. Since: cosmos-sdk 0.43

Responses

Request samples

Payload

Content type

application/json


                                  {
                                  
                                    
                                      
                                        "tx":
                                        
                                        {
                                        
                                          
                                            
                                              "body":
                                              
                                              {
                                              
                                                
                                                  
                                                    "messages":
                                                    
                                                    [
                                                    
                                                      
                                                        
                                                          
                                                          {
                                                          
                                                            
                                                              
                                                                "type_url":
                                                                "string",
                                                              
                                                            
                                                            
                                                              
                                                                "value":
                                                                "string"
                                                              
                                                            
                                                          
                                                          }
                                                        
                                                      
                                                    
                                                    ],
                                                  
                                                
                                                
                                                  
                                                    "memo":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "timeout_height":
                                                    "string",
                                                  
                                                
                                                
                                                  
                                                    "extension_options":
                                                    
                                                    [
                                                    
                                                      
                                                        
                                                          
                                                          {
                                                          
                                                            
                                                              
                                                                "type_url":
                                                                "string",
                                                              
                                                            
                                                            
                                                              
                                                                "value":
                                                                "string"
                                                              
                                                            
                                                          
                                                          }
                                                        
                                                      
                                                    
                                                    ],
                                                  
                                                
                                                
                                                  
                                                    "non_critical_extension_options":
                                                    
                                                    [
                                                    
                                                      
                                                        
                                                          
                                                          {
                                                          
                                                            
                                                              
                                                                "type_url":
                                                                "string",
                                                              
                                                            
                                                            
                                                              
                                                                "value":
                                                                "string"
                                                              
                                                            
                                                          
                                                          }
                                                        
                                                      
                                                    
                                                    ]
                                                  
                                                
                                              
                                              },
                                            
                                          
                                          
                                            
                                              "auth_info":
                                              
                                              {
                                              
                                                
                                                  
                                                    "signer_infos":
                                                    
                                                    [
                                                    
                                                      
                                                        
                                                          
                                                          {
                                                          
                                                            
                                                              
                                                                "public_key":
                                                                
                                                                {
                                                                
                                                                  
                                                                    
                                                                      "type_url":
                                                                      "string",
                                                                    
                                                                  
                                                                  
                                                                    
                                                                      "value":
                                                                      "string"
                                                                    
                                                                  
                                                                
                                                                },
                                                              
                                                            
                                                            
                                                              
                                                                "mode_info":
                                                                
                                                                {
                                                                
                                                                  
                                                                    
                                                                      "single":
                                                                      
                                                                      {
                                                                      
                                                                        
                                                                          
                                                                            "mode":
                                                                            "SIGN_MODE_UNSPECIFIED"
                                                                          
                                                                        
                                                                      
                                                                      },
                                                                    
                                                                  
                                                                  
                                                                    
                                                                      "multi":
                                                                      
                                                                      {
                                                                      
                                                                        
                                                                          
                                                                            "bitarray":
                                                                            
                                                                            {
                                                                            
                                                                              
                                                                                
                                                                                  "extra_bits_stored":
                                                                                  0,
                                                                                
                                                                              
                                                                              
                                                                                
                                                                                  "elems":
                                                                                  "string"
                                                                                
                                                                              
                                                                            
                                                                            },
                                                                          
                                                                        
                                                                        
                                                                          
                                                                            "mode_infos":
                                                                            
                                                                            [
                                                                            
                                                                              
                                                                                
                                                                                  {
                                                                                    }
                                                                                
                                                                              
                                                                            
                                                                            ]
                                                                          
                                                                        
                                                                      
                                                                      }
                                                                    
                                                                  
                                                                
                                                                },
                                                              
                                                            
                                                            
                                                              
                                                                "sequence":
                                                                "string"
                                                              
                                                            
                                                          
                                                          }
                                                        
                                                      
                                                    
                                                    ],
                                                  
                                                
                                                
                                                  
                                                    "fee":
                                                    
                                                    {
                                                    
                                                      
                                                        
                                                          "amount":
                                                          
                                                          [
                                                          
                                                            
                                                              
                                                                
                                                                {
                                                                
                                                                  
                                                                    
                                                                      "denom":
                                                                      "string",
                                                                    
                                                                  
                                                                  
                                                                    
                                                                      "amount":
                                                                      "string"
                                                                    
                                                                  
                                                                
                                                                }
                                                              
                                                            
                                                          
                                                          ],
                                                        
                                                      
                                                      
                                                        
                                                          "gas_limit":
                                                          "string",
                                                        
                                                      
                                                      
                                                        
                                                          "payer":
                                                          "string",
                                                        
                                                      
                                                      
                                                        
                                                          "granter":
                                                          "string"
                                                        
                                                      
                                                    
                                                    }
                                                  
                                                
                                              
                                              },
                                            
                                          
                                          
                                            
                                              "signatures":
                                              
                                              [
                                              
                                                
                                                  
                                                    "string"
                                                  
                                                
                                              
                                              ]
                                            
                                          
                                        
                                        },
                                      
                                    
                                    
                                      
                                        "tx_bytes":
                                        "string"
                                      
                                    
                                  
                                  }

GetTxsEvent fetches txs by event.

query Parameters

events	Array of strings events is the list of transaction event type.
pagination.key	string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offset	string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limit	string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_total	boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverse	boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43
order_by	string Default: "ORDER_BY_UNSPECIFIED" Enum: "ORDER_BY_UNSPECIFIED" "ORDER_BY_ASC" "ORDER_BY_DESC" ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case. ORDER_BY_ASC: ORDER_BY_ASC defines ascending order ORDER_BY_DESC: ORDER_BY_DESC defines descending order

Responses

BroadcastTx broadcast transaction.

Request Body schema: application/json

tx_bytes

string <byte>

tx_bytes is the raw transaction.

mode

string

Default: "BROADCAST_MODE_UNSPECIFIED"

Enum: "BROADCAST_MODE_UNSPECIFIED" "BROADCAST_MODE_BLOCK" "BROADCAST_MODE_SYNC" "BROADCAST_MODE_ASYNC"

BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.

BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
BROADCAST_MODE_BLOCK: BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for the tx to be committed in a block.
BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.
BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.

Responses

Request samples

Payload

Content type

application/json


                                  {
                                  
                                    
                                      
                                        "tx_bytes":
                                        "string",
                                      
                                    
                                    
                                      
                                        "mode":
                                        "BROADCAST_MODE_UNSPECIFIED"
                                      
                                    
                                  
                                  }

GetTx fetches a tx by hash.

path Parameters

hash

required

string

hash is the tx hash to query, encoded as a hex string.